org.eclipse.vtp.framework.interactions.voice.vxml
Class BasicOutputSet

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.Widget
      org.eclipse.vtp.framework.interactions.voice.vxml.Output
          org.eclipse.vtp.framework.interactions.voice.vxml.BasicOutput
              org.eclipse.vtp.framework.interactions.voice.vxml.BasicOutputSet

All Implemented Interfaces:

VXMLConstants

public class BasicOutputSet
extends BasicOutput

The OutputSet class allows the combination of Outputs into a single output for the IVR to render to the caller. The outputs will be rendered in the order they are added.

Version:

2.0

Author:

Trip Gilman, Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

BasicOutputSet()
Constructs a new instance of OutputSet whose list of outputs is initially empty.

Method Summary

void	addOutput(BasicOutput output) Appends the BasicOutput to the list of outputs to render to the caller.
BasicOutput[]	getOutputs() Returns the list of outputs in this set.
void	removeOutput(BasicOutput output) Removes the BasicOutput from the list of outputs to render to the caller.
protected void	writeOutputs(org.xml.sax.ContentHandler outputHandler) Write the outputs in this set to the specified content handler.
void	writeWidget(org.xml.sax.ContentHandler outputHandler) Writes the content of this widget to an XML content handler.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.Widget

toString, writeAttribute, writeChildren, writeChildren, writeWidget, writeWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicOutputSet

public BasicOutputSet()

Constructs a new instance of OutputSet whose list of outputs is initially empty.

Method Detail

getOutputs

public BasicOutput[] getOutputs()

Returns the list of outputs in this set.

Returns:

The list of outputs in this set.

addOutput

public void addOutput(BasicOutput output)
               throws java.lang.NullPointerException

Appends the BasicOutput to the list of outputs to render to the caller.

Parameters:

output - The BasicOutput instance to append to the list.

Throws:

java.lang.NullPointerException - If the supplied action is null.

removeOutput

public void removeOutput(BasicOutput output)
                  throws java.lang.NullPointerException

Removes the BasicOutput from the list of outputs to render to the caller.

Parameters:

output - The BasicOutput instance to remove from the list.

Throws:

java.lang.NullPointerException - If the supplied action is null.

writeWidget

public void writeWidget(org.xml.sax.ContentHandler outputHandler)
                 throws java.lang.NullPointerException,
                        org.xml.sax.SAXException

Description copied from class: Widget

Writes the content of this widget to an XML content handler.

Specified by:

writeWidget in class Widget

Parameters:

outputHandler - The handler to write this widget to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of this widget fails.

writeOutputs

protected void writeOutputs(org.xml.sax.ContentHandler outputHandler)
                     throws java.lang.NullPointerException,
                            org.xml.sax.SAXException

Write the outputs in this set to the specified content handler.

Parameters:

outputHandler - The content handler to write to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of one of the actions fails.